<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>UniMRCP: mrcp_session.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">UniMRCP
   &#160;<span id="projectnumber">1.5.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6719ab1f1f7655efc2fa43f7eb574fd1.html">libs</a></li><li class="navelem"><a class="el" href="dir_0c98097257c2ae0d9b869d8640598357.html">mrcp-signaling</a></li><li class="navelem"><a class="el" href="dir_37247a4dbe52d673a7d6d4bedd51464d.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">mrcp_session.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Abstract MRCP Session.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="mrcp__sig__types_8h_source.html">mrcp_sig_types.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="mpf__types_8h_source.html">mpf_types.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="apt__string_8h_source.html">apt_string.h</a>&quot;</code><br/>
</div>
<p><a href="mrcp__session_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__session__t.html">mrcp_session_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__session__request__vtable__t.html">mrcp_session_request_vtable_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__session__response__vtable__t.html">mrcp_session_response_vtable_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcp__session__event__vtable__t.html">mrcp_session_event_vtable_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1f399c8180385f4bb5eadec208264ede"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#a1f399c8180385f4bb5eadec208264ede">MRCP_SESSION_PTR</a>(session)&#160;&#160;&#160;(session)</td></tr>
<tr class="separator:a1f399c8180385f4bb5eadec208264ede"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab804888805fa24448a2552ea1790a834"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#ab804888805fa24448a2552ea1790a834">MRCP_SESSION_SID</a>(session)&#160;&#160;&#160;(session)-&gt;id.buf ? (session)-&gt;id.buf : &quot;new&quot;</td></tr>
<tr class="separator:ab804888805fa24448a2552ea1790a834"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac149a95d25a8f0ee41c8ce7ecb8b44f8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#ac149a95d25a8f0ee41c8ce7ecb8b44f8">MRCP_SESSION_PTRSID</a>(session)&#160;&#160;&#160;<a class="el" href="mrcp__session_8h.html#a1f399c8180385f4bb5eadec208264ede">MRCP_SESSION_PTR</a>(session), <a class="el" href="mrcp__session_8h.html#ab804888805fa24448a2552ea1790a834">MRCP_SESSION_SID</a>(session)</td></tr>
<tr class="separator:ac149a95d25a8f0ee41c8ce7ecb8b44f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a35e0e86027033004c4a9936040cdd71f"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structmrcp__session__request__vtable__t.html">mrcp_session_request_vtable_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#a35e0e86027033004c4a9936040cdd71f">mrcp_session_request_vtable_t</a></td></tr>
<tr class="separator:a35e0e86027033004c4a9936040cdd71f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2327cb1bc2f09614b1678550618562bb"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structmrcp__session__response__vtable__t.html">mrcp_session_response_vtable_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#a2327cb1bc2f09614b1678550618562bb">mrcp_session_response_vtable_t</a></td></tr>
<tr class="separator:a2327cb1bc2f09614b1678550618562bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07d194d350b1e5352d1f6b28bbe8b424"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structmrcp__session__event__vtable__t.html">mrcp_session_event_vtable_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#a07d194d350b1e5352d1f6b28bbe8b424">mrcp_session_event_vtable_t</a></td></tr>
<tr class="separator:a07d194d350b1e5352d1f6b28bbe8b424"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5715e44c8a10cad33fa08cf0fbb14c17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrcp__session__t.html">mrcp_session_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#a5715e44c8a10cad33fa08cf0fbb14c17">mrcp_session_create</a> (apr_size_t padding)</td></tr>
<tr class="separator:a5715e44c8a10cad33fa08cf0fbb14c17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5660f17ef1cd9e5f16d69cff142ff20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrcp__session__t.html">mrcp_session_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#ae5660f17ef1cd9e5f16d69cff142ff20">mrcp_session_create_ex</a> (apr_pool_t *pool, <a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> take_ownership, apr_size_t padding)</td></tr>
<tr class="separator:ae5660f17ef1cd9e5f16d69cff142ff20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fcd720dd3009b5e2c97471b50429de7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrcp__session_8h.html#a8fcd720dd3009b5e2c97471b50429de7">mrcp_session_destroy</a> (<a class="el" href="structmrcp__session__t.html">mrcp_session_t</a> *session)</td></tr>
<tr class="separator:a8fcd720dd3009b5e2c97471b50429de7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract MRCP Session. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a1f399c8180385f4bb5eadec208264ede"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MRCP_SESSION_PTR</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">session</td><td>)</td>
          <td>&#160;&#160;&#160;(session)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Macro to log session pointers </p>

</div>
</div>
<a class="anchor" id="ac149a95d25a8f0ee41c8ce7ecb8b44f8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MRCP_SESSION_PTRSID</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">session</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="mrcp__session_8h.html#a1f399c8180385f4bb5eadec208264ede">MRCP_SESSION_PTR</a>(session), <a class="el" href="mrcp__session_8h.html#ab804888805fa24448a2552ea1790a834">MRCP_SESSION_SID</a>(session)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Macro to log session pointers and string identifiers </p>

</div>
</div>
<a class="anchor" id="ab804888805fa24448a2552ea1790a834"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MRCP_SESSION_SID</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">session</td><td>)</td>
          <td>&#160;&#160;&#160;(session)-&gt;id.buf ? (session)-&gt;id.buf : &quot;new&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Macro to log session string identifiers </p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a07d194d350b1e5352d1f6b28bbe8b424"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structmrcp__session__event__vtable__t.html">mrcp_session_event_vtable_t</a> <a class="el" href="structmrcp__session__event__vtable__t.html">mrcp_session_event_vtable_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MRCP session event vtable declaration </p>

</div>
</div>
<a class="anchor" id="a35e0e86027033004c4a9936040cdd71f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structmrcp__session__request__vtable__t.html">mrcp_session_request_vtable_t</a> <a class="el" href="structmrcp__session__request__vtable__t.html">mrcp_session_request_vtable_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MRCP session request vtable declaration </p>

</div>
</div>
<a class="anchor" id="a2327cb1bc2f09614b1678550618562bb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structmrcp__session__response__vtable__t.html">mrcp_session_response_vtable_t</a> <a class="el" href="structmrcp__session__response__vtable__t.html">mrcp_session_response_vtable_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MRCP session response vtable declaration </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a5715e44c8a10cad33fa08cf0fbb14c17"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmrcp__session__t.html">mrcp_session_t</a>* mrcp_session_create </td>
          <td>(</td>
          <td class="paramtype">apr_size_t&#160;</td>
          <td class="paramname"><em>padding</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create new memory pool and allocate session object from the pool. </p>

</div>
</div>
<a class="anchor" id="ae5660f17ef1cd9e5f16d69cff142ff20"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmrcp__session__t.html">mrcp_session_t</a>* mrcp_session_create_ex </td>
          <td>(</td>
          <td class="paramtype">apr_pool_t *&#160;</td>
          <td class="paramname"><em>pool</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td>
          <td class="paramname"><em>take_ownership</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">apr_size_t&#160;</td>
          <td class="paramname"><em>padding</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Allocate session object from the provided memory pool. Take over the ownership of the pool, if take_ownership is TRUE </p>

</div>
</div>
<a class="anchor" id="a8fcd720dd3009b5e2c97471b50429de7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mrcp_session_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structmrcp__session__t.html">mrcp_session_t</a> *&#160;</td>
          <td class="paramname"><em>session</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destroy session and assosiated memory pool. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 22 2017 10:11:48 for UniMRCP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
